步骤 yaml 描述语言

属性名称

含义

是否必填

默认值

哪些 Type的item 可以使用

name

作为该 item 的唯一标识，用于 step.sh 中环境变量的 key

是

无

全部

type

item的不同类型决定了其展现形式。

• input

• password

• textarea

• shell

• select

• checkbox

是

无

全部

rules

该item的校验规则，比如

rules:
  -required     # 表示该字段是必须的
  -length:        # 校验输入长度
     min: 4
     max: 10
  -regex: xxxxxx    # 校验正则

否

无

input/password

label

该 item 在表单中显示的标题

是

无

全部

datasource

数据源。

静态数据源的 value 是数组：

datasource:
  - label: 选项1
    value: value1
  - label: 选项2
    value: value2

否

无

select

showCondition

该 item 的显示条件，比如：

- name: abc
  label: 参数 abc
  type: select
  datasource:
    - label: 选项1
      value: 123
    - label: 选项2
      value: 456
- name: edf
  label: 参数 edf
  type: input
  showCondition: ${abc} == "123"

该示例标识，只有参数 abc 为选项 1 时，才展示参数 edf 的配置选项

否

无

所有

value

默认值

否

无

input

description

在item的右边显示一个问号，显示提示信息。

否

无

所有

input

普通的输入框。

password

一个界面显示为星号的输入框。

textarea

一个普通文本域。

shell

一个对 bash 语法展示高亮的文本域。

select

下拉框。

checkbox

一个checkbox，选中时，值为true，未选中时，值为false。